Skip to content

Conversation

@harryswift01
Copy link
Contributor

Summary

This PR improves the README.md by introducing a Project Status section that organises key badges (CI, docs, PyPI, coverage) into a clean Markdown table, making the project’s health and release status easier to understand at a glance.

Changes

Add Project Status table to README:

  • Added a ## Project Status section near the top of the README.
  • Grouped badges into a two-column Markdown table with categories: Build, Documentation, PyPI, and Quality.

Impact

  • Enhances readability and professionalism of the README.
  • Makes it easier for users and contributors to quickly see build, docs, package, and coverage status.
  • Provides a clearer template structure for future CCPBioSim Python projects to follow.

Added project status section with badges for build, documentation, PyPI, and quality.
@harryswift01 harryswift01 self-assigned this Dec 11, 2025
@harryswift01 harryswift01 linked an issue Dec 11, 2025 that may be closed by this pull request
@harryswift01 harryswift01 merged commit 4636749 into main Dec 11, 2025
11 checks passed
@harryswift01 harryswift01 deleted the 29-status-badges branch December 11, 2025 11:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Status badges (CI, Docs, DOI, PyPI, Coverage, Zenodo)

2 participants